ODStorageUnitRefIterator

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods

ODStorageUnitRefIterator

Superclasses
ODObject
Subclasses
none

An object of the ODStorageUnitRefIterator class provides access to all persistent references in a currently focused value.

Description
If a value in a storage unit contains persistent references, a storage-unit reference iterator can provide access to each of those persistent references. For example, a caller might need to access all referenced storage units in a clone operation. A caller can also use a storage-unit reference iterator to access the persistent reference in any storage unit value. This practice might be helpful for utilities that fix up cross-references or index a document. Persistent references cannot be created or removed during iteration, and the storage unit must remain focused to the value on which the storage-unit reference iterator is iterating.
Callers create a storage-unit reference iterator object by calling its storage unit's CreateStorageUnitRefIterator method (page 678), which returns a reference to a storage-unit reference iterator object.
For more information on cloning, see the chapters on storage and data transfer in the OpenDoc Programmer's Guide for the MacOS. For more information on accessing objects through iterators, see "Accessing Objects Through Iterators" on page 473 in OpenDoc Programmer's Guide.

Methods
This section presents summary descriptions of the ODStorageUnitRefIterator methods grouped according to purpose, followed by detailed descriptions in alphabetical order.
Accessing

First
Begins the iteration and obtains a copy of the first persistent reference, if it exists, in the currently focused value of the storage unit.
Next
Obtains a copy of the next persistent reference, if it exists, in the currently focused value of the storage unit.
Iterator Testing

IsNotComplete
Returns a Boolean value that indicates whether the iteration is incomplete.

Methods
First
IsNotComplete
Next